home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Vk / VkInput.z / VkInput
Encoding:
Text File  |  1998-10-20  |  6.0 KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkIIIInnnnppppuuuutttt((((3333xxxx))))                                                        VVVVkkkkIIIInnnnppppuuuutttt((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkInput - Encapsulation class for input callbacks on file descriptors
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkInput.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.            VkInput(void);
  20.            virtual void ~VkInput(void);
  21.  
  22.  
  23.    CCCCoooonnnnffffiiiigggguuuurrrraaaattttiiiioooonnnn
  24.            void attach(int fd, XtInputMask mask);
  25.            void remove(void);
  26.  
  27.  
  28.    AAAAcccccccceeeessssssss FFFFuuuunnnnccccttttiiiioooonnnnssss
  29.            int fd(void);
  30.            int id(void);
  31.  
  32.  
  33. PPPPRRRROOOOTTTTEEEECCCCTTTTEEEEDDDD PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  34.    PPPPrrrrooootttteeeecccctttteeeedddd DDDDaaaattttaaaa MMMMeeeemmmmbbbbeeeerrrrssss
  35.            XtInputId _id;
  36.            int _fd;
  37.  
  38.  
  39. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  40.           VkInput is a base class intended to encapsulate the mechanism for
  41.           setting up object-oriented callbacks on file descriptors.  The Xt
  42.           event model supports other input sources via _X_t_A_p_p_A_d_d_I_n_p_u_t(), and
  43.           the VkInput class is an object-oriented interface to this mechanism.
  44.  
  45.  
  46.  
  47. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  48.    VVVVkkkkIIIInnnnppppuuuutttt(((())))
  49.            VkInput(void);
  50.            virtual void ~VkInput(void);
  51.  
  52.  
  53.           Creates a VkInput object with no state.  Use the _a_t_t_a_c_h() method to
  54.           specify an input source.
  55.  
  56.    aaaattttttttaaaacccchhhh(((())))
  57.            void attach(int fd, XtInputMask mask);
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkIIIInnnnppppuuuutttt((((3333xxxx))))                                                        VVVVkkkkIIIInnnnppppuuuutttt((((3333xxxx))))
  71.  
  72.  
  73.  
  74.           Attaches the VkInput object to a specific input source.  If an input
  75.           source was already attached, it is detached first.  Once this method
  76.           is called, the VkInput::inputCallback callback will get called when
  77.           input becomes available.  The callData parameter to the callback
  78.           will be a (VkInput *).
  79.  
  80.    rrrreeeemmmmoooovvvveeee(((())))
  81.            void remove(void);
  82.  
  83.  
  84.           Detaches from the previously-attached input source.
  85.  
  86.    ffffdddd(((())))
  87.            int fd(void);
  88.  
  89.  
  90.           Returns the file descriptor last specified in _a_t_t_a_c_h().
  91.  
  92.    iiiidddd(((())))
  93.            XtInputId id(void);
  94.  
  95.  
  96.           Returns the XtInputId returned by _X_t_A_p_p_A_d_d_T_i_m_e_I_n_p_u_t().  Each
  97.           attached VkInput object will have a unique XtInputId.
  98.  
  99. DDDDAAAATTTTAAAA MMMMEEEEMMMMBBBBEEEERRRR DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  100.    ____iiiidddd
  101.            XtInputId _id;
  102.  
  103.  
  104.           XtInputId from _X_t_A_p_p_A_d_d_T_i_m_e_I_n_p_u_t().
  105.  
  106.    ____ffffdddd
  107.            int _fd;
  108.  
  109.  
  110.           File descriptor specified in _a_t_t_a_c_h().
  111.  
  112.    iiiinnnnppppuuuuttttCCCCaaaallllllllbbbbaaaacccckkkk
  113.            static const const char* inputCallback;
  114.  
  115.  
  116.           ViewKit-style callback when input becomes available.  The callData
  117.           parameter to the callback will be a (VkInput *).
  118.  
  119. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  120.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  121.           callCallbacks(),  className(),  addCallback(), removeCallback,
  122.           removeAllCallbacks(), hasCallbacks(),  cloneCallbacks(),
  123.           cloneCallback()
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkIIIInnnnppppuuuutttt((((3333xxxx))))                                                        VVVVkkkkIIIInnnnppppuuuutttt((((3333xxxx))))
  137.  
  138.  
  139.  
  140. CCCCLLLLAAAASSSSSSSSEEEESSSS UUUUSSSSEEEEDDDD BBBBYYYY TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  141.      VkApp
  142.  
  143. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  144.      VkCallbackObject
  145.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  146.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  147.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  148.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.